home *** CD-ROM | disk | FTP | other *** search
/ Apple WWDC 1996 / WWDC96_1996 (CD).toast / Technology Materials / MacOS 8 Resources / Developer Tools / Mac OS 8 Interfaces & Libraries / Interfaces / AIncludes / BlockStoragePlugin.a < prev    next >
Encoding:
Text File  |  1996-05-01  |  41.9 KB  |  1,233 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        BlockStoragePlugin.a
  3. ;
  4. ;    Contains:    Block Storage Plug In Programming Interface
  5. ;
  6. ;    Version:    Technology:    Copland
  7. ;                Release:    Universal Interfaces 3.0d3 on Copland DR1
  8. ;
  9. ;    Copyright:    © 1984-1996 by Apple Computer, Inc.  All rights reserved.
  10. ;
  11. ;    Bugs?:        If you find a problem with this file, send the file and version
  12. ;                information (from above) and the problem description to:
  13. ;
  14. ;                    Internet:    apple.bugs@applelink.apple.com
  15. ;                    AppleLink:    APPLE.BUGS
  16. ;
  17. ;
  18.     IF &TYPE('__BLOCKSTORAGEPLUGIN__') = 'UNDEFINED' THEN
  19. __BLOCKSTORAGEPLUGIN__ SET 1
  20.  
  21.     IF &TYPE('__TYPES__') = 'UNDEFINED' THEN
  22.     include 'Types.a'
  23.     ENDIF
  24.     IF &TYPE('__ERRORS__') = 'UNDEFINED' THEN
  25.     include 'Errors.a'
  26.     ENDIF
  27.     IF &TYPE('__FILEMANAGERTYPES__') = 'UNDEFINED' THEN
  28.     include 'FileManagerTypes.a'
  29.     ENDIF
  30.     IF &TYPE('__NAMEREGISTRY__') = 'UNDEFINED' THEN
  31.     include 'NameRegistry.a'
  32.     ENDIF
  33.     IF &TYPE('__BLOCKSTORAGE__') = 'UNDEFINED' THEN
  34.     include 'BlockStorage.a'
  35.     ENDIF
  36.     IF &TYPE('__IOMEMORYLISTS__') = 'UNDEFINED' THEN
  37.     include 'IOMemoryLists.a'
  38.     ENDIF
  39.     IF FOR_SYSTEM8_PREEMPTIVE THEN
  40. ;
  41. ;******************************************************************************
  42. ; *******************************************************************************
  43. ; *******************************************************************************
  44. ;
  45. ;    Plug In Constants
  46. ;    
  47. ; *******************************************************************************
  48. ; *******************************************************************************
  49. ; *****************************************************************************
  50. ;
  51. ;
  52. ;******************************************************************************
  53. ;    
  54. ;    Options to a BSIOFunc
  55. ;    
  56. ; *****************************************************************************
  57. ;
  58.  
  59. kBSRead                            EQU        0
  60. kBSWrite                        EQU        1
  61. ;
  62. ;******************************************************************************
  63. ;
  64. ;    Mapping Plug-In Level of Confidence values
  65. ;    
  66. ; *****************************************************************************
  67. ;
  68.  
  69. kBSMPIDeviceNotSupported        EQU        0
  70. kBSMPIDeviceTypeRecognized        EQU        1
  71. kBSMPIDeviceMfrRecognized        EQU        2
  72. kBSMPIDeviceModelRecognized        EQU        3
  73. kBSMPIDeviceMediaRecognized        EQU        4
  74. ; typedef UInt32                         BSMPIConfidenceLevel
  75.  
  76. ;
  77. ;******************************************************************************
  78. ;
  79. ;    Mapping Plug-In Level of Confidence values
  80. ;    
  81. ; *****************************************************************************
  82. ;
  83.  
  84. kBSCPIDeviceNotSupported        EQU        0
  85. kBSCPIDeviceTypeRecognized        EQU        1
  86. kBSCPIDeviceMfrRecognized        EQU        2
  87. kBSCPIDeviceModelRecognized        EQU        3
  88. ; typedef UInt32                         BSCPIConfidenceLevel
  89.  
  90. ;
  91. ;******************************************************************************
  92. ;
  93. ;    Plug In Version - this tracks the revision of the plug-in interface and
  94. ;        should be placed in the version field of the plug-in interface structure
  95. ;    
  96. ; *****************************************************************************
  97. ;
  98.  
  99. kBSPlugInInterfaceVersion        EQU        $02011996
  100. ;
  101. ;******************************************************************************
  102. ;
  103. ;    BSIOStatus values
  104. ;    
  105. ; *****************************************************************************
  106. ;
  107.  
  108. kBSIOCompleted                    EQU        1
  109. kBSIOContinuing                    EQU        2
  110. kBSIOFailed                        EQU        3
  111. kBSIONotStarted                    EQU        4
  112. ; typedef UInt32                         BSIOStatus
  113.  
  114. ;
  115. ;******************************************************************************
  116. ; *******************************************************************************
  117. ; *******************************************************************************
  118. ; 
  119. ;    Types
  120. ;    
  121. ; *******************************************************************************
  122. ; *******************************************************************************
  123. ; *****************************************************************************
  124. ;
  125. ; typedef void *                        BSStorePtr
  126.  
  127. ; typedef void *                        BSContainerPtr
  128.  
  129. ; typedef void *                        BSIORequestBlockPtr
  130.  
  131. ; typedef OSStatus                         BSIOErrors
  132.  
  133. ;
  134. ;******************************************************************************
  135. ;    BSErrorList:  another structure to manage I/O success/failure.
  136. ;
  137. ;    BSErrorList data structure allows a Mapping Plug-In to keep track of the
  138. ;    current state of each transfer request sent to it by the Block Storage client.  If transfers complete
  139. ;    successfully, a pointer 0 is returned.  If an error occurs, a linked list (?) of these data structures
  140. ;    is returned specifying the exact state of each transfer request.
  141. ;
  142. ;    startingBlock:        The initial transfer block of this fragment of the request
  143. ;    blockCount:            The number of blocks to be transfered including the startingBlock
  144. ;    status:                A constant representing the final state of the transfer of the blocks:
  145. ;                                 kIONotStarted:                No processing was begun on these blocks
  146. ;                                kIOStarted:                    The BS Plug-In began to process the blocks
  147. ;                                kIOToFamily:                The request was sent to the device family
  148. ;                                kIOComplete:                The request completed normally
  149. ;                                 kIOFailed:                    The request failed to complete execution
  150. ;    error:                The exact error, if any
  151. ;    xferID:                An index representing which request of a multiple-request I/O this is
  152. ;     next:                A pointer to the next data structure (could be eliminated in favor of indices)
  153. ; *****************************************************************************
  154. ;
  155. BSErrorList                RECORD 0
  156. startingBlock             ds        BSByteCount        ; offset: $0 (0)
  157. length                     ds        BSByteCount        ; offset: $8 (8)
  158. status                     ds.l    1                ; offset: $10 (16)
  159. error                     ds.l    1                ; offset: $14 (20)
  160. xferID                     ds.l    1                ; offset: $18 (24)
  161. next                     ds.l    1                ; offset: $1C (28)
  162. sizeof                     EQU *                    ; size:   $20 (32)
  163.                         ENDR
  164. ; typedef struct BSErrorList *            BSErrorListPtr
  165.  
  166. ;
  167. ;****************************************************************************
  168. ;
  169. ;    BSStoreMPIComponent describes a component of a Store.  A component may
  170. ;    be an external device or another Store.  This is the internal form of
  171. ;    BSStoreComponent.
  172. ;    
  173. ; ***************************************************************************
  174. ;
  175. BSStoreMPIComponent        RECORD 0
  176. componentType             ds.l    1                ; offset: $0 (0)
  177. startingOffset             ds        BSByteCount        ; offset: $4 (4)        ;  Where in the Store this 
  178. ;  component will be placed 
  179. sourceNode                 ds        RegEntryRef        ; offset: $C (12)        ;  Physical components 
  180. srcStore                 ds.l    1                ; offset: $1C (28)        ;  Logical components 
  181. partitionInfo             ds        BSPartitionDescriptor ; offset: $20 (32) ;  Logical components 
  182.                          ORG 358
  183. sizeof                     EQU *                    ; size:   $166 (358)
  184.                         ENDR
  185. ; typedef struct BSStoreMPIComponent *    BSStoreMPIComponentPtr
  186.  
  187. ;
  188. ;******************************************************************************
  189. ;
  190. ;    BSStoreMPIInfo - Information about the Store that the Mapping Plug-in can
  191. ;        provide
  192. ;        
  193. ; *****************************************************************************
  194. ;
  195. BSStoreMPIInfo            RECORD 0
  196. curState                 ds.l    1                ; offset: $0 (0)
  197. storeSize                 ds        BSByteCount        ; offset: $4 (4)
  198. readBlockSize             ds        BSByteCount        ; offset: $C (12)        ;  minimum read size & granularity 
  199. writeBlockSize             ds        BSByteCount        ; offset: $14 (20)        ;  minimum write size & granularity 
  200. isEjectable                 ds.b    1                ; offset: $1C (28)
  201. isWriteable                 ds.b    1                ; offset: $1D (29)
  202. hasAutoEjectHardware     ds.b    1                ; offset: $1E (30)
  203. isFormattable             ds.b    1                ; offset: $1F (31)
  204. isPartitionable             ds.b    1                ; offset: $20 (32)
  205. isFilesystem             ds.b    1                ; offset: $21 (33)
  206. reserved1                 ds.b    1                ; offset: $22 (34)
  207. reserved2                 ds.b    1                ; offset: $23 (35)
  208. curFormat                 ds        BSStoreFormatInfo ; offset: $24 (36)
  209. possibleFormats             ds.b    8 * BSStoreFormatInfo.sizeof ; offset: $34 (52)
  210. name                     ds.b    48                ; offset: $B4 (180)
  211. sizeof                     EQU *                    ; size:   $E4 (228)
  212.                         ENDR
  213. ; typedef struct BSStoreMPIInfo *        BSStoreMPIInfoPtr
  214.  
  215. ;
  216. ;******************************************************************************
  217. ;
  218. ;    BSStorePPIInfo - Information about the Store that the Partitioning Plug-in 
  219. ;        can provide
  220. ;        
  221. ; *****************************************************************************
  222. ;
  223. BSStorePPIInfo            RECORD 0
  224. numPartitions             ds.l    1                ; offset: $0 (0)
  225. maxPartitions             ds.l    1                ; offset: $4 (4)
  226. sizeof                     EQU *                    ; size:   $8 (8)
  227.                         ENDR
  228. ; typedef struct BSStorePPIInfo *        BSStorePPIInfoPtr
  229.  
  230. ;
  231. ;******************************************************************************
  232. ;
  233. ;    BSContainerPIInfo - Information about the Container that the Container
  234. ;        Plug-in can provide
  235. ;        
  236. ; *****************************************************************************
  237. ;
  238. BSContainerPIInfo        RECORD 0
  239. numChildren                 ds.l    1                ; offset: $0 (0)
  240. isEjectable                 ds.b    1                ; offset: $4 (4)
  241.                          ORG 6
  242. sizeof                     EQU *                    ; size:   $6 (6)
  243.                         ENDR
  244. ; typedef struct BSContainerPIInfo *    BSContainerPIInfoPtr
  245.  
  246. ;
  247. ;******************************************************************************
  248. ; *******************************************************************************
  249. ; *******************************************************************************
  250. ;
  251. ;    Plug-In Interface Functions
  252. ;    
  253. ; *******************************************************************************
  254. ; *******************************************************************************
  255. ; *****************************************************************************
  256. ;
  257. ;
  258. ;******************************************************************************
  259. ; *******************************************************************************
  260. ;
  261. ;    Mapping Plug-In Interface
  262. ;    
  263. ; *******************************************************************************
  264. ; *****************************************************************************
  265. ;
  266. ;
  267. ;******************************************************************************
  268. ;    BSMappingPIExamine - Plug-in's opportunity to examine a device and determine
  269. ;            if it is an appropriate plug-in for it
  270. ;    
  271. ;    Inputs:        examineStore - a pointer to the in-process Store to be examined
  272. ;    
  273. ;    Outputs:    confidence - level of confidence the plug-in has that the plugin
  274. ;                is the correct one
  275. ;    
  276. ;    Returns:    E_BSSuccess if no errors happened examining the device.  
  277. ;                If an error happened, the error received from the other family is
  278. ;                returned
  279. ; *****************************************************************************
  280. ;
  281. ;
  282. ;******************************************************************************
  283. ;
  284. ;    BSMappingPIInit - Plug-in's initialization routine.  Called when plug-in
  285. ;            is selected for a Store.  Plug-in's opportunity to initialize
  286. ;            device, allocate data structures, etc.
  287. ;    
  288. ;    Inputs:        initStore - a pointer to the Store this plug-in will be attached
  289. ;                    to
  290. ;    Outputs:    curState - the current state of the media
  291. ;    
  292. ;    Returns:    E_BSSuccess if successful
  293. ;    
  294. ; *****************************************************************************
  295. ;
  296. ;
  297. ;******************************************************************************
  298. ;
  299. ;    BSMappingPICleanup - Plug-in's dispose routine.  Called when Store is
  300. ;            being disposed of.  Should dispose of any memory or data structures
  301. ;            held for this Store, finalize all I/O for Store
  302. ;    
  303. ;    Inputs:        cleanupStore - Store that is being disposed of
  304. ;    
  305. ;    Outputs:    <none>
  306. ;    
  307. ;    Returns:    E_BSSuccess if successful
  308. ;    
  309. ; *****************************************************************************
  310. ;
  311. ;
  312. ;******************************************************************************
  313. ;    BSMappingPIIO - Plug-in's input/output routine
  314. ;    
  315. ;    Inputs:        ioStore - the Store on which IO is to be performed
  316. ;                blocks - descriptor of the blocks to do IO on
  317. ;                memory - descriptor of the memory to do IO on (memory has been prepared)
  318. ;                parentRequest - the request this request is being made on behalf of
  319. ;                options - read/write
  320. ;    
  321. ;    Outputs:    errors - where exactly the errors occured, if any
  322. ;    
  323. ;    Returns:    kBSIOContinuing if IO was started successfully and the I/O
  324. ;                    completion routine still needs to be called
  325. ;                kBSIOCompleted if IO was completed and no further action is
  326. ;                    necessary
  327. ;                kBSIOFailed if IO failed for some reason
  328. ;                kBSIONotStarted if the IO could not be started
  329. ; *****************************************************************************
  330. ;
  331. ;
  332. ;******************************************************************************
  333. ;    BSMappingPIFlush - flush plug-in's cached data (if any)
  334. ;            BSMappingPIFlush flushes the plug-in's cached data.  It is called
  335. ;            in a similar fashion to an I/O request.  BSStoreRW may be used
  336. ;            as may BSStoreFlush.
  337. ;    
  338. ;    Inputs:        flushStore - the Store on which flush is to be performed
  339. ;                parentRequest - the request this request is being made on behalf of
  340. ;    
  341. ;    Outputs:    errors - where exactly the errors occured, if any
  342. ;    
  343. ;    Returns:    kBSIOContinuing if IO was started successfully and the I/O
  344. ;                    completion routine still needs to be called
  345. ;                kBSIOCompleted if IO was completed and no further action is
  346. ;                    necessary
  347. ;                kBSIOFailed if IO failed for some reason
  348. ;                kBSIONotStarted if the IO could not be started
  349. ; *****************************************************************************
  350. ;
  351. ;
  352. ;******************************************************************************
  353. ;    BSMappingPIAddComponent - Notifies Plug-in about new components to be added
  354. ;        to it
  355. ;    
  356. ;    Inputs:        destStore - the Store the blocks are to be mapped into
  357. ;                newComponent - the new Component to be mapped in
  358. ;    
  359. ;    Outputs:    storeNewInfo - the new information about the Store
  360. ;
  361. ;    
  362. ;    Returns:    E_BSSuccess if successful
  363. ;                E_BSMPITooManyMappings if no more mappings can be handled
  364. ;                E_BSMPIOutOfStoreBounds if the start of the destination blocks 
  365. ;                    would cause a gap in the Store
  366. ;    
  367. ; *****************************************************************************
  368. ;
  369. ;
  370. ;******************************************************************************
  371. ;    BSMappingPIGoToState - Requests plug-in to take Store to the specified 
  372. ;            accessibility state.  
  373. ;    
  374. ;    Inputs:        theStore - Store to take to the state
  375. ;                gotoState - what state to go to (possible states defined above)
  376. ;                                
  377. ;    
  378. ;    Outputs:    <none>
  379. ;
  380. ;    Returns:    E_BSSuccess if successful
  381. ;    
  382. ; *****************************************************************************
  383. ;
  384. ;
  385. ;******************************************************************************
  386. ;    BSMappingPIFormatMedia - tells plug-in to do a low-level format of the media
  387. ;    
  388. ;    Inputs:        formatStore - Store to format
  389. ;    
  390. ;    Outputs:    <none>
  391. ;    
  392. ;    Returns:    E_BSSuccessful if successful
  393. ;    
  394. ; *****************************************************************************
  395. ;
  396. ;
  397. ;******************************************************************************
  398. ;    BSMappingPIGetInfo - gets information about the device and the plug-in
  399. ;    
  400. ;    Inputs:        formatStore - Store to format
  401. ;    
  402. ;    Outputs:    info - the filled in information
  403. ;    
  404. ;    Returns:    E_BSSuccessful if successful
  405. ;    
  406. ; *****************************************************************************
  407. ;
  408. ;
  409. ;******************************************************************************
  410. ;    BSMappingIOCompletion - I/O completion routine for a mapping plug-in
  411. ;    
  412. ;    Inputs:        theStore:  - A pointer to the Store in question
  413. ;                finishedPrivateData - A pointer to the private data the Mapping 
  414. ;                    plug-in associated with this I/O
  415. ;                returnedBSErrorList - A pointer to a BSErrorList if the 
  416. ;                    triggering event came from another BS plug-in
  417. ;                returnedStatus - The OSStatus returned by the other family or 
  418. ;                    plug-in that was called
  419. ;    Outputs:    errorListPtrPtr - A pointer to a pointer to a BSErrorList.  
  420. ;                    The BSErrorList is allocated and filled in by the completion 
  421. ;                    routine if the I/O has failed.  It should be allocated using 
  422. ;                    BSErrorListAllocate and will be deallocated by the family code.
  423. ;    
  424. ;    Returns:    E_BSSuccess if successful
  425. ;
  426. ; *****************************************************************************
  427. ;
  428. BlockStoragePlugInInfo    RECORD 0
  429. version                     ds.l    1                ; offset: $0 (0)
  430. reserved1                 ds.l    1                ; offset: $4 (4)
  431. reserved2                 ds.l    1                ; offset: $8 (8)
  432. reserved3                 ds.l    1                ; offset: $C (12)
  433. sizeof                     EQU *                    ; size:   $10 (16)
  434.                         ENDR
  435. BSStoreMappingOps        RECORD 0
  436. header                     ds        BlockStoragePlugInInfo ; offset: $0 (0)
  437. DeviceExamine             ds.l    1                ; offset: $10 (16)
  438. Init                     ds.l    1                ; offset: $14 (20)
  439. Cleanup                     ds.l    1                ; offset: $18 (24)
  440. IO                         ds.l    1                ; offset: $1C (28)
  441. Flush                     ds.l    1                ; offset: $20 (32)
  442. AddComponent             ds.l    1                ; offset: $24 (36)
  443. GotoState                 ds.l    1                ; offset: $28 (40)
  444. Format                     ds.l    1                ; offset: $2C (44)
  445. GetInfo                     ds.l    1                ; offset: $30 (48)
  446. ioCompletion             ds.l    1                ; offset: $34 (52)
  447. sizeof                     EQU *                    ; size:   $38 (56)
  448.                         ENDR
  449. ; typedef struct BSStoreMappingOps *    BSStoreMappingOpsPtr
  450.  
  451. ;
  452. ;******************************************************************************
  453. ;
  454. ;    BSMPIBackgroundTask - a background task entry point for a Mapping plug-in.
  455. ;            BSMPIStartBackgroundTask may be used by the Mapping plug-in to
  456. ;            start one of these.  The task will be automatically terminated
  457. ;            after the Cleanup routine is executed
  458. ;    
  459. ;    Inputs:        theStore - the Store this is running for
  460. ;                theArg - the argument passed to BSMPIStartBackgroundTask
  461. ;                
  462. ;    Outputs:    <none>
  463. ;    
  464. ;    Returns:    Errors are ignored but will be logged.
  465. ; *****************************************************************************
  466. ;
  467. ;
  468. ;******************************************************************************
  469. ; *******************************************************************************
  470. ;
  471. ;    Partitioning Plug-In Interface
  472. ;    
  473. ; *******************************************************************************
  474. ; *****************************************************************************
  475. ;
  476. ;
  477. ;******************************************************************************
  478. ;    BSPartitioningPIExamine - Plug-in's opportunity to examine a Store and
  479. ;            determine if it's the right plug-in for it
  480. ;    
  481. ;    Inputs:        readStoreConn - a connection to the Store to be examined
  482. ;    
  483. ;    Outputs:    certainty - 0 if the plug-in did not recognize the partition
  484. ;                    map format
  485. ;                otherwise the number of bytes read
  486. ;    
  487. ;    Returns:    E_BSSuccess if no errors occured
  488. ;                E_BSPPIOutOfResources if memory or other resource couldn't
  489. ;                    be allocated
  490. ;                otherwise the Block Storage error from the I/O
  491. ;    
  492. ; *****************************************************************************
  493. ;
  494. ;
  495. ;******************************************************************************
  496. ;    BSPartitioningPIInit - Plug-in's initialization routine.  Called when 
  497. ;            plug-in is selected for a Store.  Plug-in's opportunity to 
  498. ;            initialize device, allocate data structures, etc.
  499. ;    
  500. ;    Inputs:        initStore - pointer to the Store the plug-in is being attached to
  501. ;                    
  502. ;    Outputs:    <none>
  503. ;    
  504. ;    Returns:    E_BSSuccess if successful
  505. ;    
  506. ; *****************************************************************************
  507. ;
  508. ;
  509. ;******************************************************************************
  510. ;
  511. ;    BSPartitioningPICleanup - Plug-in's dispose routine.  Called when Store is
  512. ;            being disposed of.  Should dispose of any memory or data structures
  513. ;            held for this Store and flush the partition map if necessary
  514. ;    
  515. ;    Inputs:        cleanupStore - Store that is being disposed of
  516. ;    
  517. ;    Outputs:    <none>
  518. ;    
  519. ;    Returns:    E_BSSuccess if successful
  520. ;    
  521. ; *****************************************************************************
  522. ;
  523. ;
  524. ;******************************************************************************
  525. ;    BSPartitioningPIInitializeMap - lays down a new partition map on a Store (plug-in has
  526. ;            already been attached)
  527. ;    
  528. ;    Inputs:        initStore - the Store to be initialized
  529. ;    
  530. ;    Outputs:    <none>
  531. ;    
  532. ;    Returns:    E_BSSuccess if successful
  533. ;                otherwise, Block Storage error if I/O fails
  534. ;    
  535. ; *****************************************************************************
  536. ;
  537. ;
  538. ;******************************************************************************
  539. ;    BSPartitioningPIGetInfo - Gets information about the partition map and the
  540. ;        partitioning plug-in
  541. ;    
  542. ;    Inputs:        store - the Store to read from
  543. ;    
  544. ;    Outputs:    info - the filled in information
  545. ;    
  546. ;    Returns:    E_BSSuccess if successful
  547. ;    
  548. ; *****************************************************************************
  549. ;
  550. ;
  551. ;******************************************************************************
  552. ;    BSPartitioningPIGetEntry - Get a particular partition map entry
  553. ;    
  554. ;    Inputs:        readStore - the Store
  555. ;                entryNum - which entry to read
  556. ;                
  557. ;    Outputs:    retEntry - pointer to a BSPartitionDescriptor that's filled in
  558. ;                    with the entry
  559. ;    
  560. ;    Returns:    E_BSSuccess if successful
  561. ;                E_BSPPIPartitionNonExistant if that entry does not exist
  562. ;                other Block Storage error if I/O problem
  563. ;    
  564. ; *****************************************************************************
  565. ;
  566. ;
  567. ;******************************************************************************
  568. ;    BSPartitioningSetEntry - Sets the information in a particular partition map
  569. ;            entry
  570. ;    
  571. ;    Inputs:        
  572. ;    
  573. ;    Outputs:    
  574. ;    
  575. ;    Returns:    
  576. ;    
  577. ; *****************************************************************************
  578. ;
  579. BSStorePartitioningOps    RECORD 0
  580. header                     ds        BlockStoragePlugInInfo ; offset: $0 (0)
  581. Examine                     ds.l    1                ; offset: $10 (16)
  582. Init                     ds.l    1                ; offset: $14 (20)
  583. Cleanup                     ds.l    1                ; offset: $18 (24)
  584. InitializeMap             ds.l    1                ; offset: $1C (28)
  585. GetInfo                     ds.l    1                ; offset: $20 (32)
  586. GetEntry                 ds.l    1                ; offset: $24 (36)
  587. SetEntry                 ds.l    1                ; offset: $28 (40)
  588. sizeof                     EQU *                    ; size:   $2C (44)
  589.                         ENDR
  590. ; typedef struct BSStorePartitioningOps * BSStorePartitioningOpsPtr
  591.  
  592. ;
  593. ;******************************************************************************
  594. ; *******************************************************************************
  595. ;
  596. ;    Container Plug-In Interface
  597. ;    
  598. ; *******************************************************************************
  599. ; *****************************************************************************
  600. ;
  601. ;
  602. ;******************************************************************************
  603. ;
  604. ;    BSContainerPIExamine - Called to allow the Container plug-in to verify
  605. ;        that it is correct for the Container
  606. ;
  607. ;    Inputs:        initContainer - the Container in question    
  608. ;
  609. ;    Outputs:    levelOfConfidence - how confident the plug-in is that it is the
  610. ;                    correct one
  611. ;
  612. ;    Returns:    E_BSSuccess if successful
  613. ;
  614. ; *****************************************************************************
  615. ;
  616. ;
  617. ;******************************************************************************
  618. ;
  619. ;    BSContainerPIInit - Plug-in's initialization routine.  Called when 
  620. ;        plug-in is selected for a Container.  Plug-in's opportunity to 
  621. ;        initialize device, allocate data structures, etc.
  622. ;
  623. ;    Inputs:        initContainer - a pointer to the Container this plug-in will 
  624. ;                be attached to
  625. ;    Outputs:    info - information about the new Container
  626. ;                backgroundTask - if true, the BackgroundTask entry point will
  627. ;                    be invoked in its own private task.
  628. ;    
  629. ;    Returns:    E_BSSuccess if successful
  630. ;    
  631. ; *****************************************************************************
  632. ;
  633. ;
  634. ;******************************************************************************
  635. ;
  636. ;    BSContainerPICleanup - cleans up plug-in state
  637. ;
  638. ;    Inputs:        container - the Container to clean up for
  639. ;
  640. ;    Outputs:    <none>
  641. ;
  642. ;    Returns:    E_BSSuccess if successful
  643. ;
  644. ; *****************************************************************************
  645. ;
  646. ;
  647. ;******************************************************************************
  648. ;
  649. ;    BSContainerPIGoToState - Tells the Container to go the specified state
  650. ;
  651. ;    Inputs:        container - the Container to take to the state
  652. ;                accessState - the state to go to
  653. ;
  654. ;    Outputs:    <none>
  655. ;
  656. ;    Returns:    E_BSSuccess if successful
  657. ;
  658. ; *****************************************************************************
  659. ;
  660. ;
  661. ;******************************************************************************
  662. ;
  663. ;    BSContainerPIAddContainer - Informs the Container of a new sub-Container
  664. ;        being added
  665. ;
  666. ;    Inputs:        destContainer - the Container we're adding to
  667. ;                addedContainer - the Container being added
  668. ;
  669. ;    Outputs:    <none>
  670. ;
  671. ;    Returns:    E_BSSuccess if successful
  672. ;
  673. ; *****************************************************************************
  674. ;
  675. ;
  676. ;******************************************************************************
  677. ;
  678. ;    BSContainerPIGetInfo - Gets information about a Container
  679. ;
  680. ;    Inputs:        infoContainer - the Container to get information about
  681. ;
  682. ;    Outputs:    info - the filled in information buffer
  683. ;
  684. ;    Returns:    E_BSSuccess if successful
  685. ;
  686. ; *****************************************************************************
  687. ;
  688. ;
  689. ;******************************************************************************
  690. ;
  691. ;    BSContainerPIBackgroundTask - an optional entry point that will be executed
  692. ;        within its own task context if the backgroundTask flag is set on exit
  693. ;        from the Container Plug-in's init routine
  694. ;    
  695. ;    Inputs:        container - the Container the Background Task is being invoked 
  696. ;                        on behalf of
  697. ;    
  698. ;    Outputs:    <none>
  699. ;    
  700. ;    Returns:    E_BSSuccessful if successful
  701. ;    
  702. ; *****************************************************************************
  703. ;
  704. BSContainerPolicyOps    RECORD 0
  705. header                     ds        BlockStoragePlugInInfo ; offset: $0 (0)
  706. Examine                     ds.l    1                ; offset: $10 (16)
  707. Init                     ds.l    1                ; offset: $14 (20)
  708. Cleanup                     ds.l    1                ; offset: $18 (24)
  709. GoToState                 ds.l    1                ; offset: $1C (28)
  710. AddContainer             ds.l    1                ; offset: $20 (32)
  711. GetInfo                     ds.l    1                ; offset: $24 (36)
  712. BackgroundTask             ds.l    1                ; offset: $28 (40)
  713. sizeof                     EQU *                    ; size:   $2C (44)
  714.                         ENDR
  715. ; typedef struct BSContainerPolicyOps *    BSContainerPolicyOpsPtr
  716.  
  717. ;
  718. ;******************************************************************************
  719. ;
  720. ;    BSCPIBackgroundTask - a background task entry point for a Container plug-in.
  721. ;            BSCPIStartBackgroundTask may be used by the Container plug-in to
  722. ;            start one of these.  The task will be automatically terminated
  723. ;            after the Cleanup routine is executed
  724. ;    
  725. ;    Inputs:        theContainer - the Container this is running for
  726. ;                theArg - the argument passed to BSMPIStartBackgroundTask
  727. ;                
  728. ;    Outputs:    <none>
  729. ;    
  730. ;    Returns:    Errors are ignored but will be logged.
  731. ; *****************************************************************************
  732. ;
  733. ;
  734. ;******************************************************************************
  735. ; *******************************************************************************
  736. ; *******************************************************************************
  737. ; 
  738. ;    Block Storage Family Services
  739. ;    
  740. ; *******************************************************************************
  741. ; *******************************************************************************
  742. ; *****************************************************************************
  743. ;
  744. ;
  745. ;******************************************************************************
  746. ;    BSStoreRW - Request I/O from another Store.  Used by Mapping Plug-ins.
  747. ;                Not for use by Partitioning Plug-ins!!
  748. ;    
  749. ;    Inputs:        rwStore - the Store to do I/O with
  750. ;                blocks - the blocks for the transfer
  751. ;                memory - the memory for the transfer
  752. ;                parentRequest - the BSIORequestPtr that the requestor was called
  753. ;                    with
  754. ;                privateData - pointer to be given to the completion routine
  755. ;                    when it is called
  756. ;                options - read/write
  757. ;                
  758. ;    Outputs:    errors - where errors occurred, if any occurred
  759. ;    
  760. ;    Returns:    return code from other plug-in
  761. ;    
  762. ; *****************************************************************************
  763. ;
  764. ;
  765. ; extern BSIOStatus BSStoreRW(BSStorePtr rwStore, BSBlockListDescriptorRef blocks, MemListDescriptorRef memory, BSIORequestBlockPtr parentRequest, void *privateData, OptionBits options, BSErrorListPtr *errors)
  766. ;
  767.     IF GENERATINGCFM THEN
  768.         IMPORT_CFM_FUNCTION BSStoreRW
  769.     ENDIF
  770.  
  771. ;
  772. ;******************************************************************************
  773. ;    BSStoreFlush - Request another Store to flush its caches.  Used by Mapping Plug-ins.
  774. ;                Not for use by Partitioning Plug-ins!!
  775. ;    
  776. ;    Inputs:        flushStore - the Store to flush
  777. ;                parentRequest - the BSIORequestPtr that the requestor was called
  778. ;                    with
  779. ;                privateData - pointer to be given to the completion routine
  780. ;                    when it is called
  781. ;                
  782. ;    Outputs:    errors - where errors occurred, if any occurred
  783. ;    
  784. ;    Returns:    return code from other plug-in
  785. ;    
  786. ; *****************************************************************************
  787. ;
  788. ;
  789. ; extern BSIOStatus BSStoreFlush(BSStorePtr flushStore, BSIORequestBlockPtr parentRequest, void *privateData, BSErrorListPtr *errors)
  790. ;
  791.     IF GENERATINGCFM THEN
  792.         IMPORT_CFM_FUNCTION BSStoreFlush
  793.     ENDIF
  794.  
  795. ;
  796. ;******************************************************************************
  797. ;    BSTrackOtherFamilyRequest  - informs the Block Storage family code what routine 
  798. ;        should be called when the other I/O family the request is being passed to 
  799. ;        notifies the Block Storage family of its completion.  The Mapping plug-in's
  800. ;        ioCompletion routine will be called when the notification of the request
  801. ;        completion is received.
  802. ;
  803. ;    Inputs:        ioStore - Store I/O is taking place in
  804. ;                curRequest - BSIORequestBlock for which this I/O is taking place.
  805. ;                        This was the BSIORequestBlockPtr passed into the R/W 
  806. ;                        routine.
  807. ;                privateData - Private data to be passed back when the completion routine
  808. ;                        is called.
  809. ;                retNotify - Pointer to a kernel notification structure that will
  810. ;                        be filled in by BSTrackOtherFamilyRequest to be given
  811. ;                        to the other family in the async API call
  812. ;    
  813. ;    Outputs:    <none>
  814. ;    
  815. ;    Returns:    E_BSSuccess if able to track request
  816. ;
  817. ; *****************************************************************************
  818. ;
  819. ;
  820. ; extern OSStatus BSTrackOtherFamilyRequest(BSStorePtr ioStore, BSIORequestBlockPtr curRequest, void *privateData, KernelNotificationPtr retNotify)
  821. ;
  822.     IF GENERATINGCFM THEN
  823.         IMPORT_CFM_FUNCTION BSTrackOtherFamilyRequest
  824.     ENDIF
  825.  
  826. ;
  827. ;******************************************************************************
  828. ;    BSMPIStartBackgroundTask - starts a background task for a Mapping Plug-in.
  829. ;        The task will be terminated after the Cleanup routines for the Plug-in
  830. ;        is called for this Store.
  831. ;    
  832. ;    Inputs:        store - the Store the background task is being started for
  833. ;                backgroundTask - the function to start
  834. ;                arg - the argument to be passed to the function
  835. ;    
  836. ;    Outputs:    taskID - the task ID of the new task
  837. ;    
  838. ;    Returns:    E_BSSuccess if successful
  839. ;
  840. ; *****************************************************************************
  841. ;
  842. ;
  843. ; extern OSStatus BSMPIStartBackgroundTask(BSStorePtr store, BSMPIBackgroundTask backgroundTask, void *arg, TaskID *taskID)
  844. ;
  845.     IF GENERATINGCFM THEN
  846.         IMPORT_CFM_FUNCTION BSMPIStartBackgroundTask
  847.     ENDIF
  848.  
  849. ;
  850. ;******************************************************************************
  851. ;    BSCPIStartBackgroundTask - starts a background task for a Container Plug-in.
  852. ;        The task will be terminated after the Cleanup routines for the Plug-in
  853. ;        is called for this Container.
  854. ;    
  855. ;    Inputs:        container - the Container the background task is being started for
  856. ;                backgroundTask - the function to start
  857. ;                arg - the argument to be passed to the function
  858. ;    
  859. ;    Outputs:    taskID - the task ID of the new task
  860. ;    
  861. ;    Returns:    E_BSSuccess if successful
  862. ;
  863. ; *****************************************************************************
  864. ;
  865. ;
  866. ; extern OSStatus BSCPIStartBackgroundTask(BSContainerPtr container, BSCPIBackgroundTask backgroundTask, void *arg, TaskID *taskID)
  867. ;
  868.     IF GENERATINGCFM THEN
  869.         IMPORT_CFM_FUNCTION BSCPIStartBackgroundTask
  870.     ENDIF
  871.  
  872. ;
  873. ;******************************************************************************
  874. ; *******************************************************************************
  875. ;
  876. ;    Store Accessor functions
  877. ;    
  878. ; *******************************************************************************
  879. ; *****************************************************************************
  880. ;
  881. ;
  882. ;******************************************************************************
  883. ;    BSGetMappingPIPrivateData - retrieves the Mapping Plug-in's private data
  884. ;        from a Store
  885. ;    
  886. ;    Inputs:        accessStore - the Store to retrieve the data from
  887. ;    
  888. ;    Outputs:    <none>
  889. ;    
  890. ;    Returns:    pointer to data
  891. ;
  892. ; *****************************************************************************
  893. ;
  894. ;
  895. ; extern void *BSGetMappingPIPrivateData(BSStorePtr accessStore)
  896. ;
  897.     IF GENERATINGCFM THEN
  898.         IMPORT_CFM_FUNCTION BSGetMappingPIPrivateData
  899.     ENDIF
  900.  
  901. ;
  902. ;******************************************************************************
  903. ;    BSSetMappingPIPrivateData - sets the Mapping Plug-in's private data
  904. ;        for a Store
  905. ;    
  906. ;    Inputs:        accessStore - the Store to set the data in
  907. ;                privateData - pointer to the data
  908. ;    
  909. ;    Outputs:    <none>
  910. ;    
  911. ;    Returns:    <none>
  912. ;
  913. ; *****************************************************************************
  914. ;
  915. ;
  916. ; extern void BSSetMappingPIPrivateData(BSStorePtr accessStore, void *privateData)
  917. ;
  918.     IF GENERATINGCFM THEN
  919.         IMPORT_CFM_FUNCTION BSSetMappingPIPrivateData
  920.     ENDIF
  921.  
  922. ;
  923. ;******************************************************************************
  924. ;    BSGetPartitioningPIPrivateData - retrieves the Partitioning Plug-in's private 
  925. ;        data from a Store
  926. ;    
  927. ;    Inputs:        accessStore - the Store to retrieve the data from
  928. ;    
  929. ;    Outputs:    <none>
  930. ;    
  931. ;    Returns:    pointer to data
  932. ;
  933. ; *****************************************************************************
  934. ;
  935. ;
  936. ; extern void *BSGetPartitioningPIPrivateData(BSStorePtr accessStore)
  937. ;
  938.     IF GENERATINGCFM THEN
  939.         IMPORT_CFM_FUNCTION BSGetPartitioningPIPrivateData
  940.     ENDIF
  941.  
  942. ;
  943. ;******************************************************************************
  944. ;    BSSetPartitioningPIPrivateData - sets the Partitioning Plug-in's private data
  945. ;        for a Store
  946. ;    
  947. ;    Inputs:        accessStore - the Store to set the data in
  948. ;                privateData - pointer to the data
  949. ;    
  950. ;    Outputs:    <none>
  951. ;    
  952. ;    Returns:    <none>
  953. ;
  954. ; *****************************************************************************
  955. ;
  956. ;
  957. ; extern void BSSetPartitioningPIPrivateData(BSStorePtr accessStore, void *privateData)
  958. ;
  959.     IF GENERATINGCFM THEN
  960.         IMPORT_CFM_FUNCTION BSSetPartitioningPIPrivateData
  961.     ENDIF
  962.  
  963. ;
  964. ;******************************************************************************
  965. ;    BSStoreGetNumComponents - Gets the number of component Stores or Devices 
  966. ;        that have been put together into this Store
  967. ;    
  968. ;    Inputs:        accessStore - the Store to get the number of components from
  969. ;    
  970. ;    Outputs:    <none>
  971. ;    
  972. ;    Returns:    number of components
  973. ;
  974. ; *****************************************************************************
  975. ;
  976. ;
  977. ; extern ItemCount BSStoreGetNumComponents(BSStorePtr accessStore)
  978. ;
  979.     IF GENERATINGCFM THEN
  980.         IMPORT_CFM_FUNCTION BSStoreGetNumComponents
  981.     ENDIF
  982.  
  983. ;
  984. ;******************************************************************************
  985. ;    BSStoreGetComponents - Gets the information about a particular component
  986. ;        of a Store
  987. ;    
  988. ;    Inputs:        accessStore - the Store to get the number of components from
  989. ;                componentNum - which component to return
  990. ;    
  991. ;    Outputs:    component - the BSStoreComponent buffer that is filled in
  992. ;    
  993. ;    Returns:    E_BSSuccess if no problems
  994. ;
  995. ; *****************************************************************************
  996. ;
  997. ;
  998. ; extern OSStatus BSStoreGetComponent(BSStorePtr accessStore, ItemCount componentNum, BSStoreMPIComponentPtr component)
  999. ;
  1000.     IF GENERATINGCFM THEN
  1001.         IMPORT_CFM_FUNCTION BSStoreGetComponent
  1002.     ENDIF
  1003.  
  1004. ;
  1005. ;******************************************************************************
  1006. ;    BSStoreSetNumPartitions - sets the number of partitions in the Store
  1007. ;    
  1008. ;    Inputs:        accessStore - the Store to get the number of components from
  1009. ;                numPartitions - the new partition count
  1010. ;    
  1011. ;    Outputs:    <none>
  1012. ;    
  1013. ;    Returns:    <none>
  1014. ;
  1015. ; *****************************************************************************
  1016. ;
  1017. ;
  1018. ; extern void BSStoreSetNumPartitions(BSStorePtr accessStore, ItemCount numPartitions)
  1019. ;
  1020.     IF GENERATINGCFM THEN
  1021.         IMPORT_CFM_FUNCTION BSStoreSetNumPartitions
  1022.     ENDIF
  1023.  
  1024. ;
  1025. ;******************************************************************************
  1026. ;    BSStoreGetPPIConnection - Gets the Store connection for the partitioning 
  1027. ;        plug-ins
  1028. ;    
  1029. ;    Inputs:        accessStore - the Store to get connection from
  1030. ;    
  1031. ;    Outputs:    <none>
  1032. ;    
  1033. ;    Returns:    Connection to the Store (kInvalidID if none)
  1034. ;
  1035. ; *****************************************************************************
  1036. ;
  1037. ;
  1038. ; extern BSStoreConnID BSStoreGetPPIConnection(BSStorePtr accessStore)
  1039. ;
  1040.     IF GENERATINGCFM THEN
  1041.         IMPORT_CFM_FUNCTION BSStoreGetPPIConnection
  1042.     ENDIF
  1043.  
  1044. ;
  1045. ;******************************************************************************
  1046. ;    BSStoreGetAccessibilityState - Gets the current accessibility state of the Store
  1047. ;    
  1048. ;    Inputs:        accessStore - the Store to get connection from
  1049. ;    
  1050. ;    Outputs:    <none>
  1051. ;    
  1052. ;    Returns:    Store's state
  1053. ;
  1054. ; *****************************************************************************
  1055. ;
  1056. ;
  1057. ; extern BSAccessibilityState BSStoreGetAccessibilityState(BSStorePtr accessStore)
  1058. ;
  1059.     IF GENERATINGCFM THEN
  1060.         IMPORT_CFM_FUNCTION BSStoreGetAccessibilityState
  1061.     ENDIF
  1062.  
  1063. ;
  1064. ;******************************************************************************
  1065. ;    BSStoreSetAccessibilityState - Sets the current accessibility state of the Store
  1066. ;    
  1067. ;    Inputs:        accessStore - the Store to get connection from
  1068. ;                setState - the state to set the Store to
  1069. ;    
  1070. ;    Outputs:    <none>
  1071. ;    
  1072. ;    Returns:    <none>
  1073. ;
  1074. ; *****************************************************************************
  1075. ;
  1076. ;
  1077. ; extern void BSStoreSetAccessibilityState(BSStorePtr accessStore, BSAccessibilityState setState)
  1078. ;
  1079.     IF GENERATINGCFM THEN
  1080.         IMPORT_CFM_FUNCTION BSStoreSetAccessibilityState
  1081.     ENDIF
  1082.  
  1083. ;
  1084. ;******************************************************************************
  1085. ;    BSStoreGetMPIInfo - Calls the GetInfo routine of the Mapping plug-in 
  1086. ;        attached to the Store
  1087. ;    
  1088. ;    Inputs:        accessStore - the Store to get connection from
  1089. ;                info - a pointer to the buffer to put the returned info into
  1090. ;    
  1091. ;    Outputs:    <none>
  1092. ;    
  1093. ;    Returns:    <none>
  1094. ;
  1095. ; *****************************************************************************
  1096. ;
  1097. ;
  1098. ; extern OSStatus BSStoreGetMPIInfo(BSStorePtr accessStore, BSStoreMPIInfo *info)
  1099. ;
  1100.     IF GENERATINGCFM THEN
  1101.         IMPORT_CFM_FUNCTION BSStoreGetMPIInfo
  1102.     ENDIF
  1103.  
  1104. ;
  1105. ;******************************************************************************
  1106. ;    BSStoreGetPPIInfo - Calls the GetInfo routine of the Partitioning plug-in 
  1107. ;        attached to the Store
  1108. ;    
  1109. ;    Inputs:        accessStore - the Store to get connection from
  1110. ;                info - a pointer to the buffer to put the returned info into
  1111. ;    
  1112. ;    Outputs:    <none>
  1113. ;    
  1114. ;    Returns:    <none>
  1115. ;
  1116. ; *****************************************************************************
  1117. ;
  1118. ;
  1119. ; extern OSStatus BSStoreGetPPIInfo(BSStorePtr accessStore, BSStorePPIInfo *info)
  1120. ;
  1121.     IF GENERATINGCFM THEN
  1122.         IMPORT_CFM_FUNCTION BSStoreGetPPIInfo
  1123.     ENDIF
  1124.  
  1125. ;
  1126. ;******************************************************************************
  1127. ;
  1128. ;    BSMPINotifyFamilyStoreChangedState - called from a Mapping Plug-in (typically
  1129. ;        in the BackgroundTask) to inform the Block Storage Family of an 
  1130. ;        unexpected accessibility change, e.g. the media was removed or the disk
  1131. ;        spun down.
  1132. ;
  1133. ;    Inputs:        changedStore - the Store that changed
  1134. ;                newState - the state the Store is now in
  1135. ;                
  1136. ;    Outputs:    <none>
  1137. ;
  1138. ;    Returns:    E_BSSuccess if successful
  1139. ;
  1140. ; *****************************************************************************
  1141. ;
  1142. ;
  1143. ; extern OSStatus BSMPINotifyFamilyStoreChangedState(BSStorePtr changedStore, BSAccessibilityState newState)
  1144. ;
  1145.     IF GENERATINGCFM THEN
  1146.         IMPORT_CFM_FUNCTION BSMPINotifyFamilyStoreChangedState
  1147.     ENDIF
  1148.  
  1149. ;
  1150. ;******************************************************************************
  1151. ;
  1152. ;    BSMPIRequestStoreStateChange - requests a state change of the Store.  This
  1153. ;        should be used, for example, if a device has an eject button that can
  1154. ;        be monitored by the Mapping Plug-in.  If the eject button is pressed
  1155. ;        BSMPIRequestStoreStateChange should be used to notify the Family that
  1156. ;        an eject has been requested and the Family can then notify clients and
  1157. ;        flush data to the media properly.  This call waits until permission is
  1158. ;        granted or denied by the Expert.  The GoToState call of the plug-in
  1159. ;        will be invoked before this calls returns if permission is granted.
  1160. ;
  1161. ;    Inputs:        changeStore - the Store the state change will affect
  1162. ;                requestedState - the state the Store is being requested to go to
  1163. ;
  1164. ;    Outputs:    permission - true if permission was granted and the Store 
  1165. ;                    successfully went to the State requested.
  1166. ;
  1167. ;    Returns:    E_BSSuccess if successful
  1168. ;
  1169. ; *****************************************************************************
  1170. ;
  1171. ;
  1172. ; extern OSStatus BSMPIRequestStoreStateChange(BSStorePtr changeStore, BSAccessibilityState requestedState, Boolean *permission)
  1173. ;
  1174.     IF GENERATINGCFM THEN
  1175.         IMPORT_CFM_FUNCTION BSMPIRequestStoreStateChange
  1176.     ENDIF
  1177.  
  1178. ;
  1179. ;******************************************************************************
  1180. ;
  1181. ;    BSCPINotifyFamilyContainerChangedState - called from a Container Plug-in 
  1182. ;        (typically in the BackgroundTask) to inform the Block Storage Family of 
  1183. ;        an unexpected accessibility change, e.g. the media was removed.
  1184. ;
  1185. ;    Inputs:        changedStore - the Store that changed
  1186. ;                newState - the state the Store is now in
  1187. ;                
  1188. ;    Outputs:    <none>
  1189. ;
  1190. ;    Returns:    E_BSSuccess if successful
  1191. ;
  1192. ; *****************************************************************************
  1193. ;
  1194. ;
  1195. ; extern OSStatus BSCPINotifyFamilyContainerChangedState(BSContainerPtr changedContainer, BSAccessibilityState newState)
  1196. ;
  1197.     IF GENERATINGCFM THEN
  1198.         IMPORT_CFM_FUNCTION BSCPINotifyFamilyContainerChangedState
  1199.     ENDIF
  1200.  
  1201. ;
  1202. ;******************************************************************************
  1203. ;
  1204. ;    BSCPIRequestContainerStateChange - requests a state change of the Container. 
  1205. ;        This should be used, for example, if a device has an eject button that 
  1206. ;        can be monitored by the Container Plug-in.  If the eject button is pressed
  1207. ;        BSCPIRequestStoreStateChange should be used to notify the Family that
  1208. ;        an eject has been requested and the Family can then notify clients and
  1209. ;        flush data to the media properly.  This call waits until permission is
  1210. ;        granted or denied by the Expert.  The GoToState call of the plug-in
  1211. ;        will be invoked before this calls returns if permission is granted.
  1212. ;
  1213. ;    Inputs:        changeContainer - the Container the state change will affect
  1214. ;                requestedState - the state the Container is being requested to go to
  1215. ;
  1216. ;    Outputs:    permission - true if permission was granted and the Container 
  1217. ;                    successfully went to the State requested.
  1218. ;
  1219. ;    Returns:    E_BSSuccess if successful
  1220. ;
  1221. ; *****************************************************************************
  1222. ;
  1223. ;
  1224. ; extern OSStatus BSCPIRequestContainerStateChange(BSStorePtr changeContainer, BSAccessibilityState requestedState, Boolean *permission)
  1225. ;
  1226.     IF GENERATINGCFM THEN
  1227.         IMPORT_CFM_FUNCTION BSCPIRequestContainerStateChange
  1228.     ENDIF
  1229.  
  1230.     ENDIF
  1231.     ENDIF ; __BLOCKSTORAGEPLUGIN__ 
  1232.  
  1233.